docs: add docs for GtkTargetPair
authorWilliam Jon McCann <william.jon.mccann@gmail.com>
Mon, 20 Jan 2014 20:18:21 +0000 (15:18 -0500)
committerWilliam Jon McCann <william.jon.mccann@gmail.com>
Mon, 20 Jan 2014 20:18:21 +0000 (15:18 -0500)
gtk/gtkselection.h
gtk/gtkselectionprivate.h

index 2bc5fe0be9a48a8e5a72aaf1dba1e914bb9336f8..af474f3eafc369f47111c1b852005543a864e786 100644 (file)
 
 G_BEGIN_DECLS
 
+typedef struct _GtkTargetPair GtkTargetPair;
+
+/**
+ * GtkTargetPair:
+ * @target: #GdkAtom representation of the target type
+ * @flags: #GtkTargetFlags for DND
+ * @info: an application-assigned integer ID which will
+ *     get passed as a parameter to e.g the #GtkWidget::selection-get
+ *     signal. It allows the application to identify the target
+ *     type without extensive string compares.
+ *
+ * A #GtkTargetPair structure is used to represent the same
+ * information as a table of #GtkTargetEntry, but in
+ * an efficient form.
+ */
+struct _GtkTargetPair
+{
+  GdkAtom   target;
+  guint     flags;
+  guint     info;
+};
+
 /**
  * GtkTargetList:
  *
  * A #GtkTargetList structure is a reference counted list
- * of #GtkTargetPair. It is used to represent the same
- * information as a table of #GtkTargetEntry, but in
- * an efficient form. This structure should be treated as
+ * of #GtkTargetPair. This structure should be treated as
  * opaque.
  */
 typedef struct _GtkTargetList  GtkTargetList;
index 0b965f508e13f318d340d20326e64d06504980b0..8d557e827043f7812c149240c2a68e1e6dd9e981 100644 (file)
@@ -37,6 +37,7 @@ G_BEGIN_DECLS
 
 struct _GtkSelectionData
 {
+  /*< private >*/
   GdkAtom       selection;
   GdkAtom       target;
   GdkAtom       type;
@@ -48,19 +49,11 @@ struct _GtkSelectionData
 
 struct _GtkTargetList
 {
+  /*< private >*/
   GList *list;
   guint ref_count;
  };
 
-typedef struct _GtkTargetPair GtkTargetPair;
-struct _GtkTargetPair
-{
-  GdkAtom   target;
-  guint     flags;
-  guint     info;
-};
-
-
 gboolean _gtk_selection_clear           (GtkWidget         *widget,
                                          GdkEventSelection *event);
 gboolean _gtk_selection_request         (GtkWidget         *widget,